package prometheus

Import Path
	github.com/K-Phoen/grabana/target/prometheus (on go.dev)

Dependency Relation
	imports 0 packages, and imported by 8 packages

Involved Source Files

	    prometheus.go
Package-Level Type Names (total 3)

	/* sort by: alphabet | popularity */
	 type FormatMode string (basic type)
		FormatMode switches between Table, Time series, or Heatmap. Table will only work
		in the Table panel. Heatmap is suitable for displaying metrics of the
		Histogram type on a Heatmap panel. Under the hood, it converts cumulative
		histograms to regular ones and sorts series by the bucket bound.

		As Inputs Of (at least one exported)
			func Format(format FormatMode) Option
		As Types Of (total 3)
			const FormatHeatmap
			const FormatTable
			const FormatTimeSeries

	 type Option (func)
		Option represents an option that can be used to configure a prometheus query.

		As Outputs Of (at least 6)
			func Format(format FormatMode) Option
			func Hide() Option
			func Instant() Option
			func IntervalFactor(factor int) Option
			func Legend(legend string) Option
			func Ref(ref string) Option
		As Inputs Of (at least 8)
			func New(query string, options ...Option) *Prometheus
			func github.com/K-Phoen/grabana/gauge.WithPrometheusTarget(query string, options ...Option) gauge.Option
			func github.com/K-Phoen/grabana/graph.WithPrometheusTarget(query string, options ...Option) graph.Option
			func github.com/K-Phoen/grabana/heatmap.WithPrometheusTarget(query string, options ...Option) heatmap.Option
			func github.com/K-Phoen/grabana/singlestat.WithPrometheusTarget(query string, options ...Option) singlestat.Option
			func github.com/K-Phoen/grabana/stat.WithPrometheusTarget(query string, options ...Option) stat.Option
			func github.com/K-Phoen/grabana/table.WithPrometheusTarget(query string, options ...Option) table.Option
			func github.com/K-Phoen/grabana/timeseries.WithPrometheusTarget(query string, options ...Option) timeseries.Option

	 type Prometheus (struct)
		Prometheus represents a prometheus query.

		Fields (total 9)
			Expr string
			Format string
			Hidden bool
			Instant bool
			Interval string
			IntervalFactor int
			LegendFormat string
			Ref string
			Step int
		As Outputs Of (at least one exported)
			func New(query string, options ...Option) *Prometheus


Package-Level Functions (total 7)

	 func Format(format FormatMode) Option
		Format indicates how the data should be returned.

	 func Hide() Option
		Hide the query. Grafana does not send hidden queries to the data source,
		but they can still be referenced in alerts.

	 func Instant() Option
		Instant marks the query as "instant, which means Prometheus will only return the latest scrapped value.

	 func IntervalFactor(factor int) Option
		IntervalFactor sets the resolution factor.

	 func Legend(legend string) Option
		Legend sets the legend format.

	 func New(query string, options ...Option) *Prometheus
		New creates a new prometheus query.

	 func Ref(ref string) Option
		Ref sets the reference ID for this query.


Package-Level Constants (total 3)

	const FormatHeatmap FormatMode = "heatmap"
	const FormatTable FormatMode = "table"
	const FormatTimeSeries FormatMode = "time_series"

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.